CruiseControl.NET : Documentation Guidelines
This page last changed on Oct 18, 2004 by mroberts.

This page is meant for committers to the CruiseControl.NET project only

This page still needs to be thrashed out, but here are some opening thoughts

Configurable blocks should be documented under Configuring the server. The hierarchy under this page mirrors the hierarchy of the Configuration itself.

Documentation for a specific block, should be something like :

This is the introduction to my block. It shouldn't be detailed, but should give a basic overview.

Examples

Minimalist example:

this should be the smallest configuration possible, using all defaults available

<myBlockFamily type="myBlockSpecificReflectorType"/>

or

<myBlockSpecificReflectorType />

Full example:

this should give an example for every configurable value
<myBlockSpecificReflectorType param1="value1">
        <param2>value2</param2>
    </myBlockSpecificReflectorType>

Using attributes or sub tags is a stylistic choice, right now

Configuration Elements:

Node Description Type Required Default
param1 A brief description type true or false default value, or n/a if not defaultable
param2 A brief description type true or false default value, or n/a if not defaultable

Any notes should be kept short. Extra detail probably needs to belong to the next type of page.

Integration with other tools should be detailed in a page under the Using CruiseControl.NET with other applications page. These pages should detail what needs to be done across all apps (e.g. server and web) and should link to the relevant configurable block pages
Document generated by Confluence on Jun 26, 2005 17:22